Skip to content

Convert ISSUES.md into a GitHub issue form#32

Open
tas50 wants to merge 1 commit into
chef:mainfrom
tas50:docs/issue-template
Open

Convert ISSUES.md into a GitHub issue form#32
tas50 wants to merge 1 commit into
chef:mainfrom
tas50:docs/issue-template

Conversation

@tas50

@tas50 tas50 commented Jun 28, 2026

Copy link
Copy Markdown

Summary

Replaces the static ISSUES.md file with a structured GitHub issue form at .github/ISSUE_TEMPLATE/bug_report.yml, so new bug reports collect the information maintainers need (reproduction, versions, backtrace) in a consistent, guided way that renders in the GitHub "New issue" UI.

Changes

  • Add .github/ISSUE_TEMPLATE/bug_report.yml — a guided bug-report form with required/optional fields and the bug label applied automatically.
  • Remove ISSUES.md — its purpose is now served by the form.

While converting, I also corrected a few stale details carried over from ISSUES.md:

  • Fixed the repo link chefspec/chefspecchef/chefspec.
  • Replaced the deprecated knife -v with chef --version for capturing the Chef version.
  • Dropped the "paste everything output by env" field (noisy and a potential vector for leaking secrets/credentials into a public issue).
  • Added a ChefSpec version field, which the old instructions omitted.

@tas50
tas50 requested review from a team and jaymzh as code owners June 28, 2026 05:15
@tas50
tas50 force-pushed the docs/issue-template branch from 3d4d21f to db50194 Compare June 28, 2026 05:18
Replace the static ISSUES.md instructions with a structured GitHub issue
form so bug reports collect the needed details consistently. While
converting, fix the stale `chefspec/chefspec` repo link, replace the
deprecated `knife -v` with `chef --version`, drop the privacy-risky
"paste everything from env" field, and add a missing ChefSpec version
field.

Signed-off-by: Tim Smith <tsmith84@proton.me>
@tas50
tas50 force-pushed the docs/issue-template branch from db50194 to 25ef76e Compare June 28, 2026 05:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant